Documentation for TodayPlus version 0.12.0 and later. Based on documentation from srs andforum discussions. Layout and organization by fishboy.
Documentation Revision History
|
10/13/03 |
srs |
Corrections. |
|
10/27/03 |
fishboy |
Added/changed commands for version 0.9.5 and other corrections. |
|
10/28/03 |
fishboy |
Updated storevar command to indicate that 20 variables are now available. Also added version history. |
|
10/31/03 |
fishboy |
Updated for version 0.9.7. Added missing “free” variable for the storage command. Updated countdown command in Outlook Format String. |
|
11/3/03 |
fishboy |
Update for version 0.9.8. |
|
11/5/03 |
fishboy |
Corrected “if,var” condition syntax of if…else statement. Added standards information for configuration file. Corrected syntax for the duration Outlook Format String command. |
|
11/12/03 |
fishboy |
Update for version 0.10.0. Moved Version History and Weather Icon ID List information to separate files to help keep reference file size down. |
|
12/2/03 |
fishboy |
Update for version 0.10.2. Combined time and time-5 command. Other corrections. |
|
12/29/03 |
fishboy |
Added version 0.11.0 commands as well as some missing commands. Removed configuration file commands since settings now stored in registry via config.exe. |
|
1/9/03 |
fishboy |
Updated for version 0.12.0. Created new grouping of commands and added and index (alphabetic listing of commands) |
The file that specifies the layout of information within the plugin and how it reacts to user input. All commands are case sensitive. Comments can be added to the file by preceding the text with two forward slashes (//)
Specifies the starting height the plugin takes up on the today screen. Should appear at top of the skin file.
Syntax
Parameters
|
<height> |
The number of vertical pixels. |
Example
height,125
Allows for conditional execution of commands. Nested if…else statements are supported.
Syntax
If,<condition>
commands
else
elsecommands
endif
Parameters
|
<condition> |
If condition is TRUE then operations defined by commands are executed, otherwise operations defined by elsecommands are executed. Can be one of the following: (general format is <expression>,<operator>,<value>)
General online -> Tests online state. refresh ->Tests refresh state. region,<region num>,<page num> -> Test if specified page is active in the specified region. var,var<x>,<value1>,><,<value2> -> Tests if variable value is within or equal to specified values. <value1> is low value, <value2> is high. (Example, to check if var3 is >= 10 and <= 20 use: var,var3,10,><20.) var,var<x>,,>,<value> -> Tests if variable value is greater than specified numeric value. var,var<x>,,<,<value> -> Tests if variable value is less than specified numeric value. var,var<x>,,=,<value> -> Tests if variable value is equal to specified numeric value.
RSS pagecached,<num> -> Tests if particular rss link is cached or not.
Astronomy daytime,<id>,<type> -> Test if time is between specified sunrise and sunset values. <id> is the ID of a Location defined on the “Owner Info” tab of the configuration application (starting ID is 1). <type> can be official, civil, nautical, and astronomical (see suntime command’s <type options> for definitions).
System Status batterystatusunknown -> Test if application can not determine state of battery. charging -> Tests if battery is charging. externalpower -> Tests whether the Pocket PC is using an external power source. extbatcharging -> Test if external battery is charging. extbatstatusunknown -> Test if application can not determine state of external battery. storage,<storage id from config> -> Tests whether a storage shortcut is available. Use an ID assigned to a “Storage Paths” entry on the “Time / Storage” tab of the configuration application (starting ID is 1) |
Example
if,region,1,0
imagebutton,226,2,weather active.png,t,1,4,999,-1
else
imagebutton,226,2,weather.png,t,1,4,0,-1
endif
Specifies the maximum vertical height the plugin will ever be with all regions expanded. Should appear at top of the skin file. This command is processed once during the loading of the plugin so changing this value will require reloading of the plugin (select Start | Settings | Today | Items, then click OK).
Syntax
maxheight,<height>
Parameters
|
<height> |
The maximum height in pixels. |
Example
maxheight,248
Displays another Today screen application within TodayPlus.
Syntax
plugin,<x>,<y>,<width>,<height>,<id>,<next id>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of button area in pixels. |
|
<height> |
Height of button area in pixels. |
|
<id> |
ID of a plugin defined on the “Plugins” tab of the configuration application. ? |
|
<next id> |
ID of the next plugin to display. ? |
Example
plugin,0,18,240,61,0,1
plugin,0,79,240,20,1,2
Commands to display information about celestial bodies such as the Sun and Moon. See the calcvar command and if..else statement for additional astronomy operations.
Displays information about the Moon.
Syntax
moontime,<id>,<type>,<day offset>,<x>,<y>,<format>,<prepend text>,<append text>,<justification>
Parameters
|
<id> |
The ID of a City entry defined on the “Weather / RSS tab of the configuration application (starting ID is 1). |
|
<type> |
Can be one of the following:
length -> ? rise -> The time of sunrise for specified location. set -> The time of sunset for specified location. visible -> Displays the % of the moon that is visible. |
|
<day offset> |
Number of days from current day to retrieve information (0 = current day). ? |
|
<x> |
Left coordinate in pixels. |
|
<y> |
Top coordinate in pixels. |
|
<format> |
Standard time format string, except for azimuth and elevation, which require standard c printf formatting (%.02f for 2 decimal places, etc). |
|
<prepend text> |
Text to display before the value. |
|
<append text> |
Text to display after the value. |
|
<justification> |
Alignment of text display, which can be one of the following:
c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Example
moontime,1,rise,0,30,2,hh:mm,,,l
Provides information on the Sun.
Syntax
suntime,<id>,<type>,<type options>,<x>,<y>,<format>,<justification>
Parameters
|
<id> |
The ID of a City entry defined on the “Weather / RSS tab of the configuration application (starting ID is 1). |
|
<type> |
Can be one of the following:
azimuth -> The Sun’s horizontal position for the current time. Azimuth is measured clockwise from north to the point on the horizon directly below the object. daylength -> ? elevation -> The Sun’s vertical position for the current time. Elevation is measured vertically from that point on the horizon up to the object. solarnoon -> The time when the sun crosses the meridian of the observer's location (a poles shadow will point either directly north or south). sunrise -> The time of sunrise for specified location. sunset -> The time of sunset for specified location. |
|
<type options > |
sunrise/sunset options:
official -> Sunrise/Sunset. The time when the center of the Sun is geometrically 50 arcminutes below a horizontal plane. The upper limb of the Sun will appear to be tangent to the horizon. civil -> Civil Twilight. The time when the center of the Sun is geometrically 6 degrees below the horizon. The horizon is clearly defined and the brightest stars are visible under good atmospheric nautical -> Nautical Twilight. Time when the center of the sun is geometrically 12 degrees below the horizon. The horizon is indistinct, but general outlines of ground objects may be distinguishable. astronomical -> Astronomical Twilight. The time when the center of the Sun is geometrically 18 degrees below the horizon. The Sun does not contribute to sky illumination. |
|
<x> |
Left coordinate in pixels. |
|
<y> |
Top coordinate in pixels. |
|
<format> |
Standard time format string, except for azimuth and elevation, which require standard c printf formatting (%.02f for 2 decimal places, etc). |
|
<prepend text> |
Text to display before the value. |
|
<append text> |
Text to display after the value. |
|
<justification> |
Alignment of text display, which can be one of the following:
c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Example
suntime,1,sunrise,civil,24,12,hh:mm,,,l
suntime,1,sunset,civil,24,26,hh:mm,,,l
suntime,1,elevation,,3,40,%05.2f,Ele: ,°,l
Allows imagebutton and button commands to be processed for the specified region (companion to deactivatebuttons command).
Syntax
activatebuttons,<region id>
Parameters
|
<region id> |
Number ID of region to apply this setting to. |
Example
activatebuttons,12
Defines an area that when clicked on will cause the specified action to be performed. See also the imagebutton command.
Syntax
button,<x>,<y>,<width>,<height>,<target region>,<action>,<data>,<regions to update>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of button area in pixels. |
|
<height> |
Height of button area in pixels. |
|
<target region> |
Region this command acts upon. (Use -1 for no region) |
|
<action> |
Can be one of the following:
General 6 -> Data. Used to store a value in a variable given in data. ex. var1=1 (see the storevar command for more information) 13 -> Add value to variable given in <data> (format is var<x>_<num to add>). Example, to add 5 to var3 it would be: button,0,0,12,12,-1,13,var3_5. 14 -> Plays sound (wav) file specified in <data>.
Calendar 5 -> Calendar. Specifies a calendar button. <data> should specify the calendar id. 8 -> Cal next. Moves the calendar forward by one month. <data> should specify the calendar id. 9 -> Cal prev. Moves the calendar backwards by one month. <data> should specify the calendar id. 10 -> Cal reset. resets the calendar to the original offsets. <data> should specify the calendar id.
Launcher 0 -> Launch program specified in <data>. The <data> value can be the Name parameter (preceeded by %) specified by the configuration application on the “Shortcuts” tab.
POOM 11 -> Cal to outlook. Synchronizes the outlook information with the date shown on the calendar. <data> should specify the calendar id. 22 -> Outlook now. Resets POOM information to the current time. 23 -> Clear outlook cache. Clears the outlook cache of the slot specified by <data>. 24 -> Force a cache redraw of the outlook region. 25 -> Used to set the current POOM date to that specified in <data>.
Region 1 -> Next. Advance target region by +1 page. 2 -> Prev. Go back one page in target region. 3 -> Back. Jump to previous page in target region.. 4 -> Jump. Jump target region to page specified by <data>.
RSS / Weather 12 -> Display RSS feed web page in PIE. 30 -> Online. Changes rss links to online. 31 -> Offline, Changes rss links to offline. 7 -> Refresh. Tries to update data from the internet if needed.
System 40 -> Set brightness to level specified in <data> (current valid values are 0 – 4).
|
|
<data> |
Depends on <action> parameter specified. Specify “nohighlight” (without the quotes) to not have the box draw with tapping within the defined area. Proceed it with a dash (-) to use it with a parameter needed by the specified action (i.e. 1-nohighlight, where 1 is the action data). |
|
<regions to update> |
Specify which regions (comma delimited list) to update when this button is pressed. Use –1 for a full screen rerender (for example, when changing a region height). However, use it sparingly, as it is slower than specifying only the regions that need updating. Also, make sure the defregions are correctly defined. |
Example
button,2,2,15,15,-1,0,%clock, (clicking in the area defined will launch the application specified by the configuration shortcut with id name of “clock”)
button,2,2,15,15,0,4,300, (Jump to page 300 in region 0)
Causes imagebutton and button commands to be ignored for the specified region (companion to activatebuttons command)
Syntax
deactivatebuttons,<region id>
Parameters
|
<region id> |
Number ID of region to apply this setting to. |
Example
deactivatebuttons,12
Defines an area that when clicked on will cause the specified action to be performed. Also display an image at the specified location. Combines the button and image commands into one command.
Syntax
imagebutton,<x>,<y>,<image name>,<image options>,<target>,<action>,<data>,<regions to update>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<image name> |
Name of image to draw at the specified x and y coordinates. This bitmap should have an inactive button state and an active button (pressed) state. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
|
<target region> |
Region this command acts upon. |
|
<action> |
See the button command. |
|
<data> |
See the button command. |
|
<regions to update> |
Specify which regions (comma delimited list) to update when this button is pressed. Use –1 for a full screen rerender (for example, when changing a region height). However, use it sparingly, as it is slower than specifying only the regions that need updating. Also, make sure the defregions are correctly defined. |
Example
imagebutton,226,0,calendar.bmp,t,5,4,1
Same as:
image,226,0,calendar.bmp,tr
button,226,0,12,12,5,4,1
Performs the specified button action on power on. Multiple poweron buttons can also be used.
Syntax
poweron,<target region>,<action><data>,<regions to update
Parameters
|
Region this command acts upon. |
|
|
<action> |
See the button command. |
|
<data> |
See the button command. |
|
<regions to update> |
Optional - Specify which regions (comma delimited list) to update when this button is pressed. Use –1 for a full screen rerender (for example, when changing a region height). However, use it sparingly, as it is slower than specifying only the regions that need updating. Also, make sure the defregions are correctly defined. |
Example
poweron,17,4,10,1
poweron,-1,6,var25=1
Commands for displaying a calendar (four available).
Draws the actual calendar. Used in conjunction with the calendarheader command.
Syntax
calendar,<id>,<initial offset>,<x>,<y>,<horizontal spacing>,<vertical spacing>,<image>,<justification>
Parameters
|
<id> |
Specifies a calendar id. Can be 0-3, allowing for up to four independent calendars. |
|
<initial offset> |
Specifies how many months ahead/behind the calendar will be when first drawn. Use 0 for the current month and negative numbers to display prior months. |
|
<x> |
Left position of calendar in pixels |
|
<y> |
Top position of calendar in pixels |
|
<horizontal spacing> |
Width of each column in pixels |
|
<vertical spacing> |
Height of each row in pixels |
|
<image> |
Filename of image to display along with each day number. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
calendar,0,0,0,24,14,14,box.png,l
Draws the week days above the calendar (S M T W R F S). It gets the names from the “Day Abbreviations” parameter located on the “General” tab of the configuration application, so it can be localized / customized.
Syntax
calendarheader,<x>,<y>,<horizontal spacing>
Parameters
|
<x> |
Left position of the header |
|
<y> |
Top position of the header |
|
<horizontal spacing> |
Width of each header column in pixels |
Example
calendarheader,0,12,14
Clears the specified area.
Syntax
cleararea,<x>,<y>,<width>,<height>
Parameters
|
<x> |
Left position in pixels |
|
<y> |
Top position in pixels |
|
<width> |
Width of region in pixels |
|
<height> |
Height of region in pixels |
Example
cleararea,0,0,240,40
Draws and rectangle with rounded corners.
Syntax
draw,roundrect,<x>,<y>,<width>,<height>,<R_G_B>,<options>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of rectangle in pixels. |
|
<height> |
Height of rectangle in pixels. |
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
|
<options> |
h – hollow. |
Example
draw,roundrect,11,14,66,9,-1_6_-1,h
Specifies the absolute location where subsequent text/drawing commands will begin. The offsetadd command should be used in favor of this command for proper positioning of regions when using expanding/collapsing regions.
Syntax
offset,<x>,<y>
Parameters
|
<x> |
Left coordinate in pixels |
|
<y> |
Top coordinate in pixels |
Use “offset_x” in place of <x> and <y> to use the offset specified by the defregion. The x specifies which region’s defregion values to use, and -1 signifies the current region. It is good practice to put this right at the start of each region/page.
Examples
offset,0,0
offset,offset_-1,offset_-1
Specifies the new relative location (based on a previous offset or offsetadd command) where subsequent text/drawing commands will begin. Preferred positioning command to use (in favor of the offsetadd command) when using the expanding/collapsing regions.
Syntax
offsetadd,<add X>,<add y>
Parameters
|
<add X> |
Number of pixels to move location in the vertical direction. Positive values move location down, whereas negative values move location up. |
|
<add Y> |
Number of pixels to move location in the horizontal direction. Positive values move location right, whereas negative values move location left. |
Example
offsetadd,2,2
Specifies a color that should be replaced by another for subsequent drawing.
Syntax
color,replacement,<R_G_B>,<R_G_B>
Parameters
|
<R_G_B> |
Color to replace.
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
|
<R_G_B> |
Color to replace with.
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
Example
color,replacement,-1_6_-1,0_0_0
Specifies the color that should be used as the transparent color on subsequent loading of bitmaps.
Syntax
color,transparent,<R_G_B>
Parameters
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
Example
color,transparent,255_0_255
Displays an image at the specified location.
Syntax
image,<x>,<y>,<image name>,<options>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<image name> |
Filename of image to use (this is appended to the path specified in the options-imagedir command).
Can also use: %id name% -> Displays image with specified Name defined by the configuration application. |
|
<options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
image,2,2,clock-today.bmp,t
image,2,2,%owner image%,t
specifies the folder containing the bitmap files to be used.
Syntax
options,imagedir,<directory>
Parameters
|
<directory> |
Path to image files. |
Example
options,imagedir,images\attraction
Commands for launching applications. See the button command for additional launcher operations.
Displays the icon for the specified shortcut id.
Syntax
shortcut,<x>,<y>,<id>,<format>
Parameters
|
<x> |
Left position of shortcut icon in pixels. |
|
<y> |
Top position of shortcut icon in pixels. |
|
<id> |
ID of a shortcut defined on the “Shortcut” tab of the configuration application. IDs have the format of “apps-x-y” where x is the group ID and y is the shortcut ID with the group (both have a starting value of 1). |
|
<format> |
Specifies icon display size and can be one of the following:
s -> Small icon l -> Large icon |
Examples
shortcut,5,0,app1,s
General purpose analog meter. For the background, use with the image command.
Syntax
analogmeter,<x>,<y>,<meterhand image>,<image options>,<current value>,<minimum value>,<maximum value>
Parameters
|
<x> |
Left position of analog meter hand in pixels. |
|
<y> |
Top position of analog meter hand in pixels. |
|
<meterhand image> |
Filename of image to use for meter hand. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
|
<current value> |
The value to represent in the bar graph. This value should be greater than or equal to <minimum value> and less then or equal to <maximum value> |
|
<minimum value> |
The lowest value that <current value> will obtain. (Used for proper scaling of the bar graph.) |
|
<maximum value> |
The highest value that <current value> will obtain. (Used for proper scaling of the bar graph.) |
Example
analogmeter,24,34,meterhand.bmp,tr,%var20%,0,4
General purpose bar graph.
Syntax
barmeter,<x>,<y>,<width>,<height>,<bar image>,<current value>,<minimum value>,<maximum value>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of bar in pixels. |
|
<height> |
Height of bar in pixels. |
|
<bar image> |
Filename of image to use for bar display. Precede the filename with “gradient_” (omit the quotes) to have it treated as gradient file. |
|
<current value> |
The value to represent in the bar graph. This value should be greater than or equal to <minimum value> and less then or equal to <maximum value> |
|
<minimum value> |
The lowest value that <current value> will obtain. (Used for proper scaling of the bar graph.) |
|
<maximum value> |
The highest value that <current value> will obtain. (Used for proper scaling of the bar graph.) |
Example
barmeter,185,13,42,5,gradient_green-red gradient.png,%var20%,0,3
Displays an image from a collection of images within a file (useful for moon phase display).
Syntax
imagemeter,<x>,<y>,<value>,<image filename>,<image options>,<min value>,<max value>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<current value> |
The value to represent. This value should be greater than or equal to <min value> and less then or equal to <max value> |
|
<image filename> |
Filename of image to use for display. This file should contain a collection of equally sized images laid out horizontally. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
|
<min value> |
The lowest value that < value> will obtain. Used for proper scaling. |
|
<max value> |
The highest value that <value> will obtain. Used for proper scaling. |
Example
calcvar,var21,moonphase,1 (returns 0 to 7)
imagemeter,0,10,%var21%,moon phases.png,tr,0,7 (here, moon phases.png contains 8 moon graphics).
Commands to display task and agenda information. See the calcvar and button commands for additional POOM operations.
Specifies display formatting information for POOM entries (appointments and tasks).
Syntax
Syntax #1: options,<filter>,<id>
Syntax #2: options,<appointment/task format>,<prepend spacing>,<append spacing>,<total height>,<format>
Syntax #3: options,<replace day>,<replace text>
Parameters
|
<filter> |
Specifes which POOM filter. Can be one of the following:
calendarfilter taskfilter |
|
<id> |
ID assigned to a Calendar or Task filter defined on the “POOM filters” tab of the configuration application (starting ID is 1). |
|
<appointment/task format> |
Specifies which POOM format. Can be one of the following:
apptformat -> Specify display format for normal appointments. apptallday -> Specify display format for all day appointments. blanktext -> Specify display format for blank appointments/tasks. dateformat -> Specify display format of appointment/task date. taskformat -> Specify display format for normal appointments. taskoverdue -> Specify display format for overdue tasks. taskcomplete -> Specify display format for complete tasks. |
|
<prepend spacing> |
Number of pixels to place before the entry. For blanktext, a negative value will not show today’s date if it doesn't have an appointment/task. |
|
<append spacing> |
Number of pixels to place after the entry. |
|
<total height> |
Height of the entry in pixels. |
|
<format> |
See Outlook Format String below. |
|
<replace day> |
Allows replacing a POOM date with a text string. Can be one of the following:
today-text -> Replace today’s date. tomorrow-text -> Replace tomorrow’s date. |
|
<replace text> |
Text to display. May include a date format string. |
Examples
Syntax #1
options,calendarfilter,1
options,taskfilter,1
Syntax #2
options,apptformat,0,12,12,%changefont,tahoma,11,%%image,1,2,small_arrow_right.png,t%%tab,10%%countdown, days,H:mm 'hours',m 'minutes'%%tab,65%%//bold%%subject%%regularfont% %changefont,tahoma,11,i%(%startdate,MM/dd% %starttime,hh:mm%)%changefont,tahoma,12,%
options,apptallday,0,12,12,%changefont,tahoma,11,%%image,1,2,small_arrow_right.png,t%%tab,10%%countdown, days,H:mm 'hours',m 'minutes'%%tab,65%%//bold%%subject%%changefont,tahoma,12,%
options,dateformat,0,0,0,
options,blanktext,-1,12,12,
options,taskformat,0,12,12,%changefont,tahoma,11,%%image,1,2,small_arrow_right.png,t%%tab,10%%countdown, days,H:mm 'hours',m 'minutes'%%tab,65%%//bold%%subject%%changefont,tahoma,12,%
options,taskoverdue,0,12,12,%changefont,tahoma,11,%%image,1,2,small_arrow_right.png,t%%tab,10%%countdown, days,H:mm 'hours',m 'minutes'%%tab,65%%//bold%%subject%%changefont,tahoma,12,%
options,taskcomplete,0,12,12,%changefont,tahoma,11,%%image,1,2,small_arrow_right.png,t%%tab,10%%countdown, days,H:mm 'hours',m 'minutes'%%tab,65%%//bold%%subject%%changefont,tahoma,12,%
Syntax #3
options-today-text,’Today’, MMMM dd,yyyy
options-tomorrow-text,’Tomorrow’, MMMM dd,yyyy
options-today-text,’Today’
Syntax
outlook,<x>,<y>,<width>,<height>,<filter>,<cache id>,<cache max height>,<height used>,<last date>,<regions to update>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of area in pixels. |
|
<height> |
Height of area in pixels. |
|
<filter> |
Can be one of the following:
0 -> Both appointment and tasks combined 1 -> Appointments only 2 -> Tasks only |
|
<cache id> |
Can be 0-3. specifies which cache slot to use. |
|
<cache max height> |
Optional. Specifies the maximum height to cache data for. |
|
<height used> |
Optional. Stores the actual height for the specified outlook cache into the specified variable (i.e. var23). Can be used to adjust offsets. |
|
<last date> |
Optional. Stores the last displayed date for the specified outlook cache into the specified variable. |
|
<regions to update> |
Specify which regions (comma delimited list) to update. Use –1 for a full screen rerender, however, use it sparingly as it is slower than specifying only the regions that need updating. |
Examples
outlook,5,0,235,%var15%,%var9%,%var8%,228,var20,var19,11
Clears the area occupied by the specified region.
Syntax
clearregion,<region id>
Parameters
|
<region id> |
Number ID of region to clear. |
Example
clearregion,0
Used to define a group of regions (pages) and which area the regions occupy, so that the area can be redrawn properly during an update when a full rerender is not performed. It is only processed while doing a full rerender (eg on startup). This command can be placed anywhere, but may be easiest to place it after the region (usually right after the region command) so that the current offsets can be used (set parameters x and y to 0). This is easier instead of having to calculate the exact location, which would be required if it were place at the beginning of the skin file.
It is important to define an accurate defregion. The <x> and <y> values use the current offsets, so putting the defregion inside the region will make it easier to work out the widths / heights (you will only have to specify the width and height).
Syntax
defregion,<region id>,<x>,<y>,<width>,<height>,<max pages>
Parameters
|
<region id> |
Number for the region, which is used by other region commands. |
|
<x> |
Left position in pixels |
|
<y> |
Top position in pixels |
|
<width> |
Width of region in pixels |
|
<height> |
Height of region in pixels |
|
<max pages> |
Used only when determining what the next / previous page is. |
Examples
defregion,1,0,0,0,0,2 (specifies region with two pages)
defregion,17,0,0,240,18,1 (specifies region with one page that auto updates)
Used to override the current region definition (see defregion command). Can be used to redefine where a region will be displayed.
Syntax
defregion-override,<region id>,<x>,<y>,<width>,<height>,<max pages>
Parameters
|
<region id> |
Number for the region to change. |
|
<x> |
Left position in pixels |
|
<y> |
Top position in pixels |
|
<width> |
Width of region in pixels |
|
<height> |
Height of region in pixels |
|
<max pages> |
Used only when determining what the next / previous page is. |
Example
defregion-override,1,27,16,240,56,6
defregion-override,4,27,16,240,56,6
Specifies the end of a page in a region (used with region command)
Syntax
endregion,<region id>,<page number>
Parameters
|
<region id> |
Number of a region specified with region command. |
|
<page number> |
Number of this page for specified region. |
Example
endregion,1,1
Specifies which page in the region will be active on startup. It is executed only once (on startup).
Syntax
initregion,<region id>,<page>
Parameters
|
<region id> |
Specifies ID of region to apply this setting to. |
|
<page> |
Specifies starting page for specified region. |
Example
initregion,1,0
Jumps to a page within a region, executes the commands, and returns to the command after the jumpregion command.
Syntax
jumpregion,<region id>,<page>
Parameters
|
<region id> |
Number of a region |
|
<page number> |
Number of this page for specified region. |
Example
jumpregion,15,0
Specifies the start of a page in a region and all commands between this and subsequent endregion command will belong to the specified page. A “region” is a collection of “pages” and only one “page” of a region can be active at any time.
Syntax
region,<region id>,<page number>,<update interval>
Parameters
|
<region id> |
Number of a region specified with the defregion command. |
|
<page number> |
Number of this page for specified region. |
|
<update interval> |
Interval, in seconds, that updates are to occur. Can be -1 if auto update is not needed. For most purposes, -1 should be used, but can be specified for information that needs to be updated every couple of seconds (battery / storage information for example). |
Example
region,1,1,-1
Syntax
updateregions,<regions to update> in the parent region
Parameters
|
<regions to update> |
Specify which regions (comma delimited list) to update. Often used to update child regions when the parent region is updated. Note, this command must appear in a region that is above the region to be updated in the skin file. |
Example
updateregions,4,5
Commands to display RSS feed information. See the if..else statement for additional RSS operations.
Loads the specified data for the RSS feed defined on the “Weather / RSS” tab of the configuration application. This command needs to be appear before any of the RSS commands.
Syntax
load,rss,<ID>
Parameters
|
<ID> |
city/rss id from a configuration entry (starting value is 1). |
Example
load,rss,1
Displays the specified item of the loaded RSS feed. Used in conjunction with the load command.
Syntax
RSS,title,<x>,<y>,<width>,<height>,<item number>,<prepend text>,<append text>,<justification>
RSS,description,<x>,<y>,<width>,<height>,<item number>,<prepend text>,<append text>,<height used?>
Parameters
|
<variable> |
Can be one of the following:
title -> Display title of specified RSS feed item description -> Display description of specified RSS feed item |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of item in pixels. |
|
<height> |
Height of item in pixels. |
|
<item number> |
Index of the item to display (starts with 1) |
|
<prepend text> |
Text to display before the variable value. |
|
<append text> |
Text to display after the variable value. |
|
<justification> |
Can be on of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Examples
RSS,title,15,2,210,12,1,,,c
RSS,title,15,2,210,12,%var1%,,,c
RSS,description,5,14,230,36,%var1%, ,,
Commands to display information about the PPC systems. See the calcvar and button commands, and if..else statement for additional system status operations.
Displays specified battery information as text.
Syntax
battery,<variable>,<x>,<y>,<prepend text>,<append text>,<justification>
Parameters
|
<variable> |
Can be one of the following:
consumed -> Display amount of battery power consumed (not supported by all PDAs). current -> Display battery current (not supported by all PDAs). esttime -> Computed estimated time remaining. esttimeconfidence -> Confidence level of computed estimated time remaining. remaining ->Display remaining battery charge as a percent. remainingtime -> Display remaining battery uptime (not supported by all PDAs). temperature -> Display current battery temperature (not supported by all PDAs). voltage -> Display battery voltage (not supported by all PDAs). |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<prepend text> |
Text to display before the variable value. |
|
<append text> |
Text to display after the variable value. |
|
<justification> |
Can be on of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Examples
battery,remainingtime,230,24,, hr(s),r
battery,voltage,110,24,, V,r
Display remaining battery charge as an analog meter. For the background, use with the image command.
Syntax
battery,analog,<x>,<y>,<meterhand image>,<image options>
Parameters
|
<x> |
Left position of analog meter hand in pixels. |
|
<y> |
Top position of analog meter hand in pixels. |
|
<meterhand image> |
Filename of image to use for meter hand. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
battery,analog,24,34,meterhand.bmp,tr
Displays remaining battery charge as bar graph.
Syntax
battery,bar,<x>,<y>,<width>,<height>,<R_G_B>
battery,bar,<x>,<y>,<width>,<height>,<bar image>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of bar in pixels. |
|
<height> |
Height of bar in pixels. |
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
|
<bar image> |
Filename of image to use for bar display. Precede the filename with “gradient_” (omit the quotes) to have it treated as gradient file. |
Example
battery,bar,32,16,136,5,-1_8_-1
battery,bar,32,16,136,5,gradient_red-green gradient.png
Displays specified memory information as text.
Syntax
memory,<variable>,<x>,<y>,<prepend text>,<append text>,<justification>,<number format>
Parameters
|
<variable> |
Can be one of the following:
programfree -> Display amount of free program memory. programfreeprecent -> Display amount of free program memory as a percent. programused -> Display total program memory used. programusedpercent -> Display total program memory used as a percent. storagefree -> Display amount of free storage memory. storagefreepercent -> Display amount of free storage memory as a percent. storageused -> Display total storage memory used. storageusedpercent -> Display total storage memory used as a percent. total -> Display total memory available. totalused -> Display total memory used. totalusedprecent -> Display total memory used as a percent. |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<prepend text> |
Text to display before the variable value. |
|
<append text> |
Text to display after the variable value. |
|
<justification> |
Can be on of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
|
<number format> |
Optional. Specifies formatting for numeric value (i.e. %.0f specifies no decimal digits, %0.1f specifies one, etc). |
Examples
memory,totalused,120,24,, MB,c
memory,totalusedpercent,123,26,, %,l
Display total available memory as an analog meter. For the background, use with the image command.
Syntax
memory,analog,<x>,<y>,<meterhand image name>,<image options>
Parameters
|
<x> |
Left position of analog meter hand in pixels. |
|
<y> |
Top position of analog meter hand in pixels. |
|
<meterhand image> |
Filename of image to use for meter hand. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
memory,analog,101,34,meterhand.bmp,tr
Displays memory usage as a bar graph.
Syntax
memory,<variable>,<x>,<y>,<width>,<height>,<R_G_B>
memory,<variable>,<x>,<y>,<width>,<height>,<bar image>
Parameters
|
<variable> |
Can be one of the following:
barused -> Display total memory used as a bar graph (program and storage). progusedbar -> Display program memory used as a bar graph |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of bar in pixels. |
|
<height> |
Height of bar in pixels. |
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
|
<bar image> |
Filename of image to use for bar display. Precede the filename with “gradient_” (omit the quotes) to have it treated as gradient file. |
Example
memory,barused,89,16,62,5,-1_8_-1
memory,barused,52,16,136,5,gradient_green-red gradient.png
Displays specified storage information as text.
Syntax
storage,<storage id>,<variable>,<x>,<y>,<prepend>,<append>,<justification>,<number format>
Parameters
|
<storage id> |
ID assigned to a “Storage Paths” entry on the “Time / Storage” tab of the configuration application (starting ID is 1). |
|
<variable> |
Can be one of the following:
free -> Display total free memory for storage device. freepercent -> Display total free memory for storage device as a percent. total -> Display total available memory for storage device. used – Display total used memory for storage device. usedpercent -> Display total used memory for storage device as a percent. |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<prepend text> |
Text to display before the variable value. |
|
<append text> |
Text to display after the variable value. |
|
<justification> |
Can be on of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow. |
|
<number format> |
Optional. Specifies formatting for numeric value, for example number of decimal digits. (%.0f specifies no decimal digits, %0.1f specifies one, etc). |
Example
storage,cfcard1,used,196,24,, MB,c
storage,storagepath1,usedpercent,110,24,(,%),l,%.0f
Display total available storage memory as an analog meter. For the background, use with the image command.
Syntax
storage,<storage id>,analog,<x>,<y>,<meterhand image>,<image options>
Parameters
|
<storage id> |
ID assigned to a “Storage Paths” entry on the “Time / Storage” tab of the configuration application (starting ID is 1). |
|
<x> |
Left position of analog meter hand in pixels. |
|
<y> |
Top position of analog meter hand in pixels. |
|
<meterhand image> |
Filename of image to use for meter hand. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
storage,cfcard1,analog,175,34,meterhand.bmp,tr
Displays total memory used as a bar graph.
Syntax
storage,<storage id>,bar,<x>,<y>,<width>,<height>,<R_G_B>
storage,<storage id>,bar,<x>,<y>,<width>,<height>,<bar image>
Parameters
|
<storage id> |
ID assigned to a “Storage Paths” entry on the “Time / Storage” tab of the configuration application (starting ID is 1). |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<width> |
Width of bar in pixels. |
|
<height> |
Height of bar in pixels. |
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
|
<bar image> |
Filename of image to use for bar display. Precede the filename with “gradient_” (omit the quotes) to have it treated as gradient file. |
Example
storage,cfcard1,bar,165,16,62,5,image_gradient2.bmp
storage,storagepath1,bar,52,16,136,5,gradient_green-red gradient.png
Displays uptime for battery and soft resets.
Syntax
uptime,<x>,<y>,<variable>,<prepend text>,<append text>,<justification>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<variable> |
Can be one of the following:
battery,duration -> Displays the total time since the last AC power connection. softreset,duration -> Displays the total time since the last reset. softreset,time, <date format>,<time format> -> Displays the date/time of the last soft reset. <date format> (optional) specifies forma for displaying the date (see Date Format String) and <time format> (optional) specifies the format for display the time (see Time Format String). |
|
<prepend text> |
Text to display before. |
|
<append text> |
Text to display after. |
|
<date format> |
Controls layout of date text display (see Date Format String) |
|
<time format> |
Controls layout of time text display (see Time Format String). |
|
<justification> |
Can be one of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Examples
uptime,44,24,battery,duration,Uptime: ,,c
uptime,87,24,softreset,time,s, H:mm t,Soft reset: ,,l (The ‘s’ in the date format specifies system short date)
uptime,205,24,softreset,duration,(,),l
Specifes font to use with subsequent text drawing commands.
Syntax
changefont,<font name>,<size>,<format>
Parameters
|
<font name> |
Name of font to use. |
|
<font size> |
Size of font to use. |
|
<format> |
Can be any combination of the following: b -> bold i -> italics u -> underline |
Example
changefont,Tahoma,12,bu
Specifies color to use with subsequent text drawing commands.
Syntax
Parameters
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
Examples
color,font,255_255_255 (Use black)
color,font,-1_4_-1 (Use today screen text color)
Specifies color to be used for commands that can specify shadowing as one of the format/justification parameters (i.e. text command)
Syntax
color,shadow,<R_G_B>
Parameters
|
<R_G_B> |
R -> Red component (0-255) G -> Green component (0-255) B -> Blue component (0-255)
If R set to –1, then G can specify a theme color (see below). In this case the B value is irrelevant and can be set to any value (usually – 1). |
Example
color,shadow,125_125_125
Displays specified text and specified location
Syntax
text,<x>,<y>,<text/variable>,<justification>,<format>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<text> |
String to display
Other possible values:
%id name% -> Displays text with id of “Name” defined by the configuration application. [caldate] -> Displays the calendar month using the specified format string. Use this after the calendar command for it to work correctly. [name] -> Displays the name of the data loaded by the load (RSS), load (Weather), and shortcut commands). [updatetime] -> Displays last refresh time for the region using the specified format string. |
|
<justification> |
Can be one of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
|
<format> |
Controls layout of date/time text display (see Date Format String and Time Format String). Used with [caldate] and [updatetime] text values. |
Examples
text,0,0,Temperature: ,c
text,0,0,%owner name%,l
text,[caldate],c,dd/mm/yy
text,0,0,[name],ls
text,[updatetime],c,hh:mm:ss
Commands to display time information.
Displays the current time in the form of an analog clock. Use the image command to display the background for the clock.
Syntax
analogclock,<x>,<y>,<hourhand image name>,<minutehand image name>,<image options>
Parameters
|
<x> |
Left position of time display in pixels. |
|
<y> |
Top position of time display in pixels. |
|
<id> |
ID assigned to a “Time” entry on the “Time / Storage” tab of the configuration application (starting ID is 1). Set to –1 to display current local time. |
|
<hourhand image> |
Filename of image to use for hour hand. |
|
<minutehand image> |
Filename of image to use for minute hand. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
analogclock,29,27,hourhand.bmp,minutehand.bmp,tr
Displays the time as text using the specified format.
Syntax
time,<x>,<y>,<id>,<format>,<justification>,[<date format>,<time format>],[<day offset>
Parameters
|
<x> |
Left position of time display in pixels. |
|
|
<y> |
Top position of time display in pixels. |
|
|
<id> |
ID assigned to a “Time” entry on the “Time / Storage” tab of the configuration application (starting ID is 1). Set to –1 to display current local time. |
|
|
<format> |
Can be one of the following:
1 -> 12 hr format, with date 2 -> 12 hr format, no date 3 -> 24 hr format, with date 4 -> 24 hr format, no date 5 -> Use <date format> and <time format> parameters to specify date/time display format.
|
|
|
<justification> |
Alignment of time display which can be one of the following:
c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
|
|
<date format> |
Used only with format #5. Controls layout of date text display (see Date Format String). |
|
|
<time format> |
Used only with format #5. Controls layout of time text display (see Time Format String). |
|
|
<day offset> |
Specifies number of days to offset the time. * |
|
Example
time,74,42,4,2,c
time,5,0,-1,5,ls,"dddd, MMMM d",
time,29,42,-1,5,c,”ddd”, “h:mm tt”
Displays the time in the form of an analog clock. Use the image command to display the background for the clock.
Syntax
time,<x>,<y>,<id>,analog,<hourhand image>,<minutehand image>
Parameters
|
<x> |
Left position of time display in pixels. |
|
<y> |
Top position of time display in pixels. |
|
<id> |
ID assigned to a “Time” entry on the “Time / Storage” tab of the configuration application (starting ID is 1). |
|
<hourhand image> |
Filename of image to use for hour hand. |
|
<minutehand image> |
Filename of image to use for minute hand. |
Example
time,74,27,4,analog,hourhand.bmp,minutehand.bmp
Adds a value to the specified variable.
Syntax
addvar,var<x>,<y>
Parameters
|
<x> |
Numeric value for variable (0-19). |
|
<y> |
Integer to add to current contents of specified variable (use a negative number to subtract). |
Example
addvar,var3,2
Stores the specified system value or calculation into a variable.
Syntax
calcvar,var<x>,<system value>
calcvar,var<x>,<operation>,<value1>,<value2>
Parameters
|
<x> |
Numeric value of variable to use (0-19) to store system value or calculation result. |
|
<system value> |
System value to store in specified variable. Can be one of the following:
General region,<region num> -> Gets the current page number for the region. fromconfig,<var name> -> Gets value of variable defined by the configuration application. <var id> is the name parameter of the variable
Astronomy moonphase,<day offset> -> Gets the phase of the moon as a number from 0-7 (0 being a new moon and 4 being a full moon). <day offset> is the number of days from current day to retrieve the phase (0 = current day). This should follow a load (Weather) command to load the coordinates for the desired location first. elevation,<day offset> -> Gets the Sun’s current elevation. <day offset> is the number of days from current day to retrieve the phase (0 = current day). This should follow a load (Weather) command to load the coordinates for the desired location first.
POOM firstoutlookdate -> Get the starting outlook date displayed.
System Status battery -> Gets the battery charge remaining. Brightness -> Gets the system brightness level. extbattery -> Gets the external battery charge remaining. programmemoryusedpercent -> Gets the program memory used as a percent.
Weather barometer -> Gets the barometer value for today. dayofweek -> Gets the day of the week numeric value. firstvalidforecastday -> Gets first valid forecast day (1-7). weatherupdatetimediff -> Gets the last update time of the weather. |
|
<operation> |
Math operation to perform and can be one of the following:
+ -> Add ( var<x> = <value1> + <value2>) - -> Subtract ( var<x> = <value1> - <value2>) * -> Multiply ( var<x> = <value1> * <value2>) / -> Divide ( var<x> = <value1> / <value2>) |
|
<value1> |
First calculation value. |
|
<value2> |
Second calculation value. |
Example
calcvar,var29,fromconfig,numcities
calcvar,var20,/,%var20%,2
calcvar,var20,-,30,%var20%
Used to auto-adjust the height of a section (i.e. poom section) to help prevent the scroll bars from appearing. Subtracts the current y offset from the specified value (<x>) and stores it in the specified variable ( var<y> = <x> - yOffset). This variable can be used as a parameter (i.e. height) in subsequent commands (i.e. offsetadd, defregion, outlook, etc.).
Syntax
calcspace,<x>,var<y>
Parameters
|
<x> |
Number to subtract current y offset from. |
|
<y> |
Numeric value of variable to use (0-19). |
Example
calcspace,208,var15
Specifies starting a value for the specified variable on startup. It is executed only once (on startup).
Syntax
initvar,var<x>,<y>
Parameters
|
<x> |
Numeric value for variable (0-19). |
|
<y> |
Initialize specified variable to this value. |
Example
initvar,var3,2
Stores a numeric value in the specified variable. Up to twenty variables (var0-var19) are supported. Variables are used in other commands by surrounding the name with the % character (i.e. %var1%).
Syntax
storevar,var<x>=<y>
Parameters
|
<x> |
Numeric value for variable (0-19). |
|
<y> |
Numeric value to store. |
Example
storevar,var1=100
Commands to display information about the weather. See the calcvar command and if..else statement for additional weather operations.
Display data retrieved from the weather web page for current or future day.
Syntax
forecast,<variable>,<day number>,<x>,<y>,<prepend>,<append>,<justification>
Parameters
|
<variable> |
Can be one of the following:
high -> Display projected high temperature. low -> Display projected low temperature. precipitation -> Display chance of precipitation. text – Displays the text description for the daytime forecast. nighttext – Displays the text description for the nighttime forecast. date_<format string> where <format string> is valid date format string. |
|
<day number> |
Specifies which day to get forecast for (i.e. 1 = next day, 2 = two days from now, etc.). Can also be a variable (%varX%). |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<prepend text> |
Text to display before the variable value. |
|
<append text> |
Text to display after the variable value. |
|
<justification> |
Can be on of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Examples
forecast,date_ddd,2,115,0,,,c
forecast,date_ddd,%var1%,24,0,,,c
forecast,precipitation,1,74,40,R: ,%,c
Displays the daytime weather icon for the specified day.
Syntax
forecasticon,<day number>,<x>,<y>,,<image options>
Parameters
|
<day number> |
Specifies which day to get forecast for (i.e. 1 = current day, 2 = next day, etc.). Can also be a variable (%varX%). |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<icon dir> |
<not used>. Specified by the options-weathericondir, instead. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Examples
forecasticon,1,51,8,,t
forecasticon,2,97,8,,t
Loads the specified data for the city defined on the “Weather / RSS” tab of the configuration application. This command needs to appear before any weather commands.
Syntax
load,city,<ID>
Parameters
|
<ID> |
city/rss id from a configuration entry (starting value is 1). |
Example
load,city,1
Displays the nighttime weather icon for the specified day.
Syntax
forecasticon,<day number>,<x>,<y>,,<image options>
Parameters
|
<day number> |
Specifies which day to get forecast for (i.e. 1 = current day, 2 = next day, etc.). Can also be a variable (%varX%). |
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<icon dir> |
<not used>. Specified by the options-weathericondir, instead. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Examples
nightforecasticon,1,51,8,,t
nightforecasticon,2,97,8,,t
Specifies location of icons to be used with subsequent weather commands.
Syntax
options,weathericondir,<directory>,<weather icon extensions>
Parameters
|
<directory> |
Path to folder containing weather icons to use. |
|
<weather icon extensions> |
Allows use of icons other then bmp format. |
Example
options,weathericondir,images\weather.com
Display current weather data retrieved from the weather web page.
Syntax
today,<variable>,<x>,<y>,<prepend text>,<append text>,<justification>
Parameters
|
<variable> |
Can be one of the following:
city -> Display city value state -> Display state value country -> Display country value region -> Display region value date -> Display date temp -> Display current temperature barometer -> Display current barometer value humidity -> Display current humidity realtemp -> Display current real temperature (factors in run speed) uv -> Display the ultraviolet value visibility -> Display the visibility range. sky -> Display the sky status (i.e. clear, rain, cloudy, etc.) windspeed -> Display the wind speed winddir -> Display the wind direction
|
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<prepend text> |
Text to display before the variable value. |
|
<append text> |
Text to display after the variable value. |
|
<justification> |
Can be on of the following: c -> Center l -> Left r -> Right
Adding an s character at the end of this command will add a shadow to the text, whose color is defined by the color-shadow command. |
Examples
today,realtemp,140,24,,°F,r
today,humidity,28,40,H: ,%,c
Displays the icon representing the current weather conditions.
Syntax
todayicon,<x>,<y>,<icon dir>,<image options>
Parameters
|
<x> |
Left position in pixels. |
|
<y> |
Top position in pixels. |
|
<icon dir> |
Path to folder containing weather icons to use. |
|
<image options> |
Can be one of the following:
t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement
The transparency and replacement colors should be specified by the color-transparent and color-replacement commands. |
Example
todayicon,5,8,weather icons\weather.com,t
All commands should be enclosed within ‘%’. Anything not so enclosed is treated as text to display.
|
Syntax |
Description |
|
addy,<y> |
Adds <y> to the current y offset. Useful for displaying rows of text with the same horizontal alignment. |
|
bold |
Makes subsequent text display in bold font. |
|
changefont,<font name>,<font size>,<format> |
Specify font to use subsequent text display. Same as the changefont command. |
|
countdown, days,<time format><text>,<time format><text> |
Displays time until appointment/task is due. It can specify a display format for three states: one for when the countdown is >1 day (first parameter), one for when it is <1 day but > 1 hour (second parameter), and one for <1 hour (third parameter). <text> data must be enclosed in single quotes.
Example: countdown, days,H:mm 'hours',m 'minutes' |
|
line,<width>,<y>,<R_G_B> |
Draws a line at the specified <y> offset, with the specified width, using the specified color. |
|
image,<x>,<y>,<image name>,<image options> |
Draws the specified image at the specified x and y offsets. Same as the image command. |
|
newline,<y> |
Moves to a new line. Resets the x position to the left edge of the outlook region, and adds <y> to the y position. |
|
regularfont |
Makes subsequent text display in regular font. |
|
resettextcolor |
Restores text color to normal theme text color for subsequent text display. |
|
tab,<x> |
Moves the current position to <x> pixels from the left edge of the outlook region. |
|
textcolor,<R_G_B> |
Specifies the color to use for subsequent text display. |
|
Icon Commands |
|
|
iconstart,<x> |
Specifies starting x offset for any subsequent icon commands (i.e. categoryicons, remindericons, etc.) |
|
categoryicons,<x>,<y>
recurrenceicon,<x>,<y>,<image
name>,<image options> sensitivityicon,<x>,<y>,<image name>,<normal sensitivity-Type?>,<image options>
|
These commands display the specified type of icon and are used in conjunction with the outlook iconstart command.
<x> -> Specifies how much to adjust the x offset after the icon is drawn (affects location of next drawn icon). Use negative values to adjust left, positive to adjust right. <y> -> Specifies the vertical offset. <image name> -> Specifies filename of icon image. <image options> -> Can be one of the following: t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement color
For example: “iconstart,220” sets the current position of drawing icons to 220. “recurrenceicon,-10,1,recurrence.png,t” draws the recurrence icon at x=220, y=1. “remindericon,-10,1,reminder.png,t” draws the reminder icon at x=210, y=1 (if the recurrence icon was drawn, otherwise drawn at x=220, y=1) |
|
Appointments Only |
|
|
starttime,<time format> |
The start time of the appt*. |
|
endtime,<time format> |
The end time of the appt*. |
|
duration,<time format> |
The duration of the appt*. |
|
subject |
The subject of the appt*. |
|
location |
The location of the appt*. |
|
Tasks Only |
|
|
checkbox,<x>,<y>,<width>,<height>,<unchecked image name>,<checked image name>,<image options> |
Draws a check box at the specified <x> and <y> offsets and specified size.
<width>,<height> -> Specify size of image as well as the click area size. <unchecked image name> -> image to display for unselected items <checked image name> -> image to display for selected items <image options> -> Can be one of the following: t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement color |
|
enddate,<date format> |
The end date of the task*. |
|
priorityicon,<x>,<y>,<low priority image>,<normal priority image>,<high priority image>,<image options> |
Used in conjunction with the iconstart command. Specifies icon images to use for low, normal and high priority tasks.
<x> -> Specifies how much to adjust the x offset after the icon is drawn (affects location of next drawn icon). Use negative values to adjust left, positive to adjust right. <y> -> Specifies the vertical offset. <image name> -> Specifies filename of icon image. <image options> -> Can be one of the following: t -> Use transparency color r -> Use replacement color tr -> Use both transparency and replacement color |
|
startdate,<date format> |
The start date of the task*. |
|
subject |
The subject of the task |
|
Date Only |
|
|
date,<date format> |
Display the current date*. |
*See Date Format String and Time Format String for help on constructing the <date format> and <time format> strings
When the R value of the color parameter <R_G_B> is set to –1, then G can be set to one of the following values (B is ignored in this case and can be set to –1)
|
Value |
Description |
|
4 |
today screen text color |
|
5 |
start button background color |
|
6 |
today screen line color |
|
7 |
bottom bar color |
|
8 |
top bar color |
|
9 |
top bar text color |
|
13 |
notification color (left) |
|
14 |
notification color (right) |
Use the following elements to construct a format picture string. If you use spaces
to separate the elements in the format string, these spaces will appear in the same
location in the output string. The letters must be in uppercase or lowercase as shown
in the table (for example, "MM" not "mm"). Characters in the format string that are
enclosed in single quotation marks will appear in the same location and unchanged in
the output string.
|
Value |
Description |
|
d |
Day of month as digits with no leading zero for single-digit days. |
|
dd |
Day of month as digits with leading zero for single-digit days. |
|
ddd |
Day of week as a three-letter abbreviation. |
|
dddd |
Day of week as its full name. |
|
M |
Month as digits with no leading zero for single-digit months. |
|
MM |
Month as digits with leading zero for single-digit months. |
|
MMM |
Month as a three-letter abbreviation. |
|
MMMM |
Month as its full name. |
|
y |
Year as last two digits, with a leading zero for years less than 10. The same format as "yy." |
|
yy |
Year as last two digits, with a leading zero for years less than 10. |
|
yyyy |
Year represented by full four digits. |
|
gg |
Period/era string. |
For example, to get the date string
"Wed, Aug 31 94"
use the following picture string:
"ddd',' MMM dd yy"
Use the following elements to construct a format picture string. If you use spaces
to separate the elements in the format string, these spaces will appear in the same
location in the output string. The letters must be in uppercase or lowercase as shown
(for example, "ss", not "SS"). Characters in the format string that are enclosed in
single quotation marks will appear in the same location and unchanged in the output string.
|
Value |
Description |
|
h |
Hours with no leading zero for single-digit hours; 12-hour clock |
|
hh |
Hours with leading zero for single-digit hours; 12-hour clock |
|
H |
Hours with no leading zero for single-digit hours; 24-hour clock |
|
HH |
Hours with leading zero for single-digit hours; 24-hour clock |
|
m |
Minutes with no leading zero for single-digit minutes |
|
mm |
Minutes with leading zero for single-digit minutes |
|
s |
Seconds with no leading zero for single-digit seconds |
|
ss |
Seconds with leading zero for single-digit seconds |
|
t |
One character time marker string, such as A or P |
|
tt |
Multicharacter time marker string, such as AM or PM |
For example, to get the time string
"11:29:40 PM"
use the following picture string:
"hh':'mm':'ss tt"
This information is part of the Microsoft Software Development Kit for Microsoft Windows for Pocket PC 2002 (the “SDK”).
|
Timezone Index |
UTC |
Description |
|
0 |
-12:00 |
Dateline Standard Time : (GMT-12:00) Eniwetok, Kwajalein |
|
1 |
-11:00 |
Samoa Standard Time : (GMT-11:00) Midway Island, Samoa |
|
2 |
-10:00 |
Hawaiian Standard Time : (GMT-10:00) Hawaii |
|
3 |
-09:00 |
Alaskan Standard Time : (GMT-09:00) Alaska |
|
4 |
-08:00 |
Pacific Standard Time : (GMT-08:00) Pacific Time (US & Canada); Tijuana |
|
10 |
-07:00 |
Mountain Standard Time : (GMT-07:00) Mountain Time (US & Canada) |
|
15 |
-07:00 |
US Mountain Standard Time : (GMT-07:00) Arizona |
|
20 |
-06:00 |
Central Standard Time : (GMT-06:00) Central Time (US & Canada) |
|
25 |
-06:00 |
Canada Central Standard Time : (GMT-06:00) Saskatchewan |
|
28 |
-06:00 |
Central America Standard Time : (GMT-06:00) Central America |
|
30 |
-06:00 |
Mexico Standard Time : (GMT-06:00) Mexico City |
|
35 |
-05:00 |
Eastern Standard Time : (GMT-05:00) Eastern Time (US & Canada) |
|
40 |
-05:00 |
US Eastern Standard Time : (GMT-05:00) Indiana (East) |
|
45 |
-05:00 |
SA Pacific Standard Time : (GMT-05:00) Bogota, Lima,Quito |
|
50 |
-04:00 |
Atlantic Standard Time : (GMT-04:00) Atlantic Time (Canada) |
|
55 |
-04:00 |
SA Western Standard Time : (GMT-04:00) Caracas, La Paz |
|
56 |
-04:00 |
Pacific SA Standard Time : (GMT-04:00) Santiago |
|
60 |
-03:30 |
Newfoundland Standard Time : (GMT-03:30) Newfoundland |
|
63 |
-03:00 |
Greenland Standard Time : (GMT-03:00) Greenland |
|
65 |
-03:00 |
E. South America Standard Time : (GMT-03:00) Brasilia |
|
70 |
-03:00 |
SA Eastern Standard Time : (GMT-03:00) Buenos Aires, Georgetown |
|
75 |
-02:00 |
Mid-Atlantic Standard Time : (GMT-02:00) Mid-Atlantic |
|
77 |
-01:00 |
Cape Verde Standard Time : (GMT-01:00) Cape Verde Is. |
|
80 |
-01:00 |
Azores Standard Time : (GMT-01:00) Cape Verde Is. |
|
85 |
-00:00 |
GMT : (GMT) Greenwich Mean Time; Dublin, Edinburgh, Lisbon, London |
|
90 |
-00:00 |
GMT Standard Time : (GMT) Monrovia, Casablanca |
|
93 |
+01:00 |
West Central Africa Standard Time : (GMT+01:00) West Central Africa |
|
95 |
+01:00 |
Central Europe Standard Time : (GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague |
|
100 |
+01:00 |
Central European Standard Time : (GMT+01:00) Sarajevo, Skopje, Sofjia, Vilnius, Warsaw, Zagreb |
|
105 |
+01:00 |
Romance Standard Time : (GMT+01:00) Brussels, Copenhagen, Madrid, Paris |
|
110 |
+01:00 |
W. Europe Standard Time : (GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna |
|
115 |
+02:00 |
E. Europe Standard Time : (GMT+02:00) Bucharest |
|
120 |
+02:00 |
Egypt Standard Time : (GMT+02:00) Cairo |
|
125 |
+02:00 |
FLE Standard Time : (GMT+02:00) Helsinki, Riga, Tallinn |
|
130 |
+02:00 |
GTB Standard Time : (GMT+02:00) Athens, Istanbul, Minsk |
|
135 |
+02:00 |
Israel Standard Time : (GMT+02:00) Jerusalem |
|
140 |
+02:00 |
South Africa Standard Time : (GMT+02:00) Harare, Pretoria |
|
145 |
+03:00 |
Russian Standard Time : (GMT+03:00) Moscow, St. Petersburg, Volgograd |
|
150 |
+03:00 |
Arab Standard Time : (GMT+03:00) Kuwait, Riyadh |
|
153 |
+03:00 |
Arabic Standard Time : (GMT+03:00) Baghdad |
|
155 |
+03:00 |
East Africa Standard Time : (GMT+03:00) Nairobi |
|
160 |
+03:30 |
Iran Standard Time : (GMT+03:30) Tehran |
|
165 |
+04:00 |
Arabian Standard Time : (GMT+04:00) Abu Dhabi, Muscat |
|
170 |
+04:00 |
Caucasus Standard Time : (GMT+04:00) Baku, Tbilisi, Yerevan |
|
175 |
+04:30 |
Afghanistan Standard Time : (GMT+04:30) Kabul |
|
180 |
+05:00 |
Yekaterinburg Standard Time : (GMT+04:00) Yekaterinburg |
|
185 |
+05:00 |
West Asia Standard Time : (GMT+05:00) Islamabad, Karachi, Tashkent |
|
190 |
+05:30 |
India Standard Time : (GMT+05:30) Bombay, Calcutta, Madras, New Delhi |
|
193 |
+05:45 |
Nepal Standard Time : (GMT+05:45) Kathmandu |
|
195 |
+06:00 |
Central Asia Standard Time : (GMT+06:00) Astana, Dhaka |
|
197 |
+06:00 |
Central Asia North Standard Time : (GMT+06:00) Almaty, Novosibirsk |
|
200 |
+06:00 |
Sri Lanka Standard Time : (GMT+06:00) Sri Jayawardenepura |
|
203 |
+06:30 |
Myanmar Standard Time : (GMT+06:30) Yangoon |
|
205 |
+07:00 |
SE Asia Standard Time : (GMT+07:00) Bangkok, Hanoi, Jakarta |
|
207 |
+07:00 |
North Asia Standard Time : (GMT+07:00) Krasnoyarsk |
|
210 |
+08:00 |
China Standard Time : (GMT+08:00) Beijing, Chongqing, Hong Kong, Urumqi |
|
215 |
+08:00 |
Singapore Standard Time : (GMT+08:00) Singapore |
|
220 |
+08:00 |
Taipei Standard Time : (GMT+08:00) Taipei |
|
225 |
+08:00 |
West Australia Standard Time : (GMT+08:00) Perth |
|
227 |
+08:00 |
North Asia East Standard Time : (GMT+08:00) Irkutsk, Ulaanbatar |
|
230 |
+09:00 |
Korea Standard Time : (GMT+09:00) Seoul |
|
235 |
+09:00 |
Tokyo Standard Time : (GMT+09:00) Osaka, Sapporo, Tokyo |
|
240 |
+09:00 |
Yakutsk Standard Time : (GMT+09:00) Yakutsk |
|
245 |
+09:30 |
AUS Central Standard Time : (GMT+09:30) Darwin |
|
250 |
+09:30 |
Cen. Australia Standard Time : (GMT+09:30) Adelaide |
|
255 |
+10:00 |
Sydney Standard Time : (GMT+10:00) Canberra, Melbourne, Sydney |
|
260 |
+10:00 |
E Australia Standard Time : (GMT+10:00) Brisbane |
|
265 |
+10:00 |
Tasmania Standard Time : (GMT+10:00) Hobart |
|
270 |
+10:00 |
Vladivostok Standard Time : (GMT+10:00) Vladivostok |
|
275 |
+10:00 |
West Pacific Standard Time : (GMT+10:00) Guam, Port Moresby |
|
280 |
+11:00 |
Central Pacific Standard Time : (GMT+11:00) Magadan, Solomon Is., New Caledonia |
|
285 |
+12:00 |
Fiji Standard Time : (GMT+12:00) Fiji, Kamchatka, Marshall Is. |
|
290 |
+12:00 |
New Zealand Standard Time : (GMT+12:00) Auckland, Wellington |
|
300 |
+13:00 |
Tonga Standard Time : (GMT+13:00) Nuku'alofa |